#!/usr/bin/env python
# -*- coding: utf-8 -*-
#===============================================================================
# Copyright 2011 zod.yslin
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# 
# Author: zod.yslin
# Email: 
# File Name: getcomments.py
# Description: 
#   The getcomments() function looks at the source of the object and finds
#   comments on lines preceding the implementation.
# Edit History: 
#   2011-11-02    File created.
#===============================================================================
import inspect
import example

# The lines returned include the comment prefix, but any whitespace prefix is stripped off.
print inspect.getcomments(example.B.do_something)
# When a module is passed to getcomments(), the return value is always the first comment in the module.
print inspect.getcomments(example)
